

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Function Macros [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Function,Function Macros, Code Template Syntax,Macro,Macro Function, Code Template Syntax">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Function Macros</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="taggedvaluemacros.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="controlmacros.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_BodyText"><span class="f_BodyText" style="font-style: italic;">Function macros</span><span class="f_BodyText"> are a convenient way of manipulating and formatting various element data. Each function macro returns a result string. There are two primary ways to use the results of function macros:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Direct substitution of the returned string into the output, such as: </span><span class="f_Bulletlist1" style="font-style: italic;">%TO_LOWER(attName)%</span></li>
<li><span class="f_Bulletlist1">Storing the returned string as part of a variable definition such as: </span><span class="f_Bulletlist1" style="font-style: italic;">$name = %TO_LOWER(attName)%</span></li>
</ul>
<p class="p_BodyText"><span class="f_BodyText">Function macros can take parameters, which can be passed to the macros as:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">String literals, enclosed within double quotation marks</span></li>
<li><span class="f_Bulletlist1">Direct substitution macros without the enclosing percent signs</span></li>
<li><span class="f_Bulletlist1">Variable references</span></li>
<li><span class="f_Bulletlist1">Numeric literals.</span></li>
</ul>
<p class="p_BodyText"><span class="f_BodyText">Multiple parameters are passed using a comma-separated list.</span></p>
<p class="p_BodyText"><span class="f_BodyText">The available function macros are described below. Parameters are denoted by angle brackets, as in: </span><span class="f_BodyText" style="font-style: italic;">FUNCTION_NAME(&lt;param&gt;)</span><span class="f_BodyText">.</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="952" bgcolor="#efeff7" style="width:952px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="952" bgcolor="#f7f7ff" style="width:952px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">Function macros are named according to the All-Caps style, as in: </span><span class="f_TiporNoteText" style="font-weight: bold;">%CONVERT_SCOPE(opScope)%</span></p>
</td>
</tr>
</table>
</div>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">CONVERT_SCOPE(&lt;umlScope&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">For use with supported languages. Converts </span><span class="f_BodyText" style="font-style: italic;">&lt;umlScope&gt;</span><span class="f_BodyText"> to the appropriate scope keyword for the language being generated. The following table shows the conversion of </span><span class="f_BodyText" style="font-style: italic;">&lt;umlScope</span><span class="f_BodyText">&gt;</span><span class="f_BodyText"> with respect to the given language.</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="109" bgcolor="#e3e6ed" style="width:109px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Language</span></p>
</td>
<td valign="top" width="138" bgcolor="#e3e6ed" style="width:138px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Package</span></p>
</td>
<td valign="top" width="97" bgcolor="#e3e6ed" style="width:97px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Public</span></p>
</td>
<td valign="top" width="117" bgcolor="#e3e6ed" style="width:117px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Private</span></p>
</td>
<td valign="top" width="112" bgcolor="#e3e6ed" style="width:112px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Protected</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="109" style="width:109px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">C++</span></p>
</td>
<td valign="top" width="138" style="width:138px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">public</span></p>
</td>
<td valign="top" width="97" style="width:97px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">public</span></p>
</td>
<td valign="top" width="117" style="width:117px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">private</span></p>
</td>
<td valign="top" width="112" style="width:112px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="109" style="width:109px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">C#</span></p>
</td>
<td valign="top" width="138" style="width:138px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">internal</span></p>
</td>
<td valign="top" width="97" style="width:97px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">public</span></p>
</td>
<td valign="top" width="117" style="width:117px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">private</span></p>
</td>
<td valign="top" width="112" style="width:112px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="109" style="width:109px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Delphi</span></p>
</td>
<td valign="top" width="138" style="width:138px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected</span></p>
</td>
<td valign="top" width="97" style="width:97px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">public</span></p>
</td>
<td valign="top" width="117" style="width:117px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">private</span></p>
</td>
<td valign="top" width="112" style="width:112px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="109" style="width:109px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Java</span></p>
</td>
<td valign="top" width="138" style="width:138px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">&nbsp;</span></p>
</td>
<td valign="top" width="97" style="width:97px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">public</span></p>
</td>
<td valign="top" width="117" style="width:117px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">private</span></p>
</td>
<td valign="top" width="112" style="width:112px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="109" style="width:109px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">PHP</span></p>
</td>
<td valign="top" width="138" style="width:138px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">public</span></p>
</td>
<td valign="top" width="97" style="width:97px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">public</span></p>
</td>
<td valign="top" width="117" style="width:117px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">private</span></p>
</td>
<td valign="top" width="112" style="width:112px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="109" style="width:109px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">VB</span></p>
</td>
<td valign="top" width="138" style="width:138px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Protected</span></p>
</td>
<td valign="top" width="97" style="width:97px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Public</span></p>
</td>
<td valign="top" width="117" style="width:117px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Private</span></p>
</td>
<td valign="top" width="112" style="width:112px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Protected</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="109" style="width:109px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">VB .Net</span></p>
</td>
<td valign="top" width="138" style="width:138px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Friend</span></p>
</td>
<td valign="top" width="97" style="width:97px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Public</span></p>
</td>
<td valign="top" width="117" style="width:117px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Private</span></p>
</td>
<td valign="top" width="112" style="width:112px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Protected</span></p>
</td>
</tr>
</table>
</div>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">COLLECTION_CLASS(&lt;language&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Gives the appropriate collection Class for the language specified for the current linked attribute.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">CSTYLE_COMMENT(&lt;wrap_length&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Converts the notes for the element currently in scope to plain C-style comments, using /* and */.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">DELPHI_PROPERTIES(&lt;scope&gt;, &lt;separator&gt;, &lt;indent&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Generates a Delphi property.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">DELPHI_COMMENT(&lt;wrap_length&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Converts the notes for the element currently in scope to Delphi comments.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">EXEC_ADD_IN(&lt;addin_name&gt;, &lt;function_name&gt;, &lt;prm_1&gt;, ..., &lt;prm_n&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Invokes an Enterprise Architect Add-In function, which can return a result string. </span><span class="f_BodyText" style="font-style: italic;">&lt;addin_name&gt;</span><span class="f_BodyText"> and </span><span class="f_BodyText" style="font-style: italic;">&lt;function_name&gt;</span><span class="f_BodyText"> specify the names of the Add-In and function to be invoked. Parameters to the Add-In function can be specified via parameters </span><span class="f_BodyText" style="font-style: italic;">&lt;prm_1&gt;</span><span class="f_BodyText"> to </span><span class="f_BodyText" style="font-style: italic;">&lt;prm_n&gt;</span><span class="f_BodyText">. For example:</span></p>
<p class="p_Code"><span class="f_Code">$result = %EXEC_ADD_IN(&quot;MyAddin&quot;,&quot;ProcessOperation&quot;,classGUID, opGUID)%</span></p>
<p class="p_BodyText"><span class="f_BodyText">Any function that is to be called by the</span><span class="f_BodyText"> </span><span class="f_BodyText" style="font-style: italic;">EXEC_ADD_IN</span><span class="f_BodyText"> macro must have two parameters: an </span><span class="f_BodyText" style="font-style: italic;">EA.Repository</span><span class="f_BodyText"> object, and a </span><span class="f_BodyText" style="font-style: italic;">Variant</span><span class="f_BodyText"> array that contains any additional parameters from the </span><span class="f_BodyText" style="font-style: italic;">EXEC_ADD_IN</span><span class="f_BodyText"> call. Return type should be </span><span class="f_BodyText" style="font-style: italic;">Variant</span><span class="f_BodyText">. For example:</span></p>
<p class="p_Code"><span class="f_Code">Public Function ProcessOperation(Repository As EA.Repository, args As Variant) As Variant</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">FIND(&lt;src&gt;, &lt;subString&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Position of the first instance of </span><span class="f_BodyText" style="font-style: italic;">&lt;subString&gt;</span><span class="f_BodyText"> in </span><span class="f_BodyText" style="font-style: italic;">&lt;src&gt;</span><span class="f_BodyText">; </span><span class="f_BodyText"> </span><span class="f_BodyText" style="font-weight: bold;">-1</span><span class="f_BodyText"> if none.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">GET_ALIGNMENT()</span></p>
<p class="p_BodyText"><span class="f_BodyText">Returns a string where all of the text on the current line of output is converted into spaces and tabs.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">JAVADOC_COMMENT(&lt;wrap_length&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Converts the notes for the element currently in scope to </span><span class="f_BodyText" style="font-style: italic;">javadoc</span><span class="f_BodyText">-style comments.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">LEFT(&lt;src&gt;, &lt;count&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">The first </span><span class="f_BodyText" style="font-style: italic;">&lt;count&gt;</span><span class="f_BodyText"> characters of </span><span class="f_BodyText" style="font-style: italic;">&lt;src&gt;</span><span class="f_BodyText">.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">LENGTH(&lt;src&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Length of </span><span class="f_BodyText" style="font-style: italic;">&lt;src&gt;</span><span class="f_BodyText">.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">MID(&lt;src&gt;, &lt;count&gt;)</span><br>
<span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">MID(&lt;src&gt;, &lt;start&gt;, &lt;count&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Substring of </span><span class="f_BodyText" style="font-style: italic;">&lt;src&gt;</span><span class="f_BodyText"> starting at </span><span class="f_BodyText" style="font-style: italic;">&lt;start&gt;</span><span class="f_BodyText"> and including </span><span class="f_BodyText" style="font-style: italic;">&lt;count&gt;</span><span class="f_BodyText"> </span><span class="f_BodyText">characters. Where </span><span class="f_BodyText" style="font-style: italic;">&lt;count&gt;</span><span class="f_BodyText"> </span><span class="f_BodyText">is omitted the rest of the string is included.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">PI(&lt;option&gt;, &lt;value&gt;, ...)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Sets the PI for the current template to </span><span class="f_BodyText" style="font-style: italic;">&lt;value&gt;</span><span class="f_BodyText">. </span><span class="f_BodyText" style="font-style: italic;"> &lt;option&gt;</span><span class="f_BodyText"> controls when the new PI takes effect. Valid values are:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1" style="font-style: italic;">I, Immediate</span><span class="f_Bulletlist1">: the new PI is generated before the next non-empty template line</span></li>
<li><span class="f_Bulletlist1" style="font-style: italic;">N, Next</span><span class="f_Bulletlist1">: the new PI is generated after the next non-empty template line.</span></li>
</ul>
<p class="p_BodyText"><span class="f_BodyText">Multiple pairs of options are allowed in one call. For more details, see the <a href="controlmacros.htm">description of PI.</a></span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">REMOVE_DUPLICATES(&lt;source&gt;, &lt;separator&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Where </span><span class="f_BodyText" style="font-style: italic;">&lt;source&gt;</span><span class="f_BodyText"> is a </span><span class="f_BodyText" style="font-style: italic;">&lt;separator&gt;</span><span class="f_BodyText"> separated list; this removes any duplicate or empty strings.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">REPLACE(&lt;string&gt;, &lt;old&gt;, &lt;new&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Replaces all occurrences of </span><span class="f_BodyText" style="font-style: italic;">&lt;old&gt;</span><span class="f_BodyText"> with </span><span class="f_BodyText" style="font-style: italic;">&lt;new&gt;</span><span class="f_BodyText"> in the given string </span><span class="f_BodyText" style="font-style: italic;">&lt;string&gt;</span><span class="f_BodyText">.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">RESOLVE_OP_NAME()</span></p>
<p class="p_BodyText"><span class="f_BodyText">Resolves clashes in interface names where two method-from interfaces have the same name.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">RESOLVE_QUALIFIED_TYPE()</span><br>
<span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">RESOLVE_QUALIFIED_TYPE(&lt;separator&gt;)</span><br>
<span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">RESOLVE_QUALIFIED_TYPE(&lt;separator&gt;, &lt;default&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Generates a qualified type for the current attribute, linked attribute, linked parent, operation, or parameter. Enables the specification of a separator other than </span><span class="f_BodyText" style="font-style: italic; font-weight: bold;">. </span><span class="f_BodyText">and a default value for when some value is required.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">RIGHT(&lt;src&gt;, &lt;count&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">The last </span><span class="f_BodyText" style="font-style: italic;">&lt;count&gt;</span><span class="f_BodyText"> characters of </span><span class="f_BodyText" style="font-style: italic;">&lt;src&gt;</span><span class="f_BodyText">.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">TO_LOWER(&lt;string&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Converts </span><span class="f_BodyText" style="font-style: italic;">&lt;string&gt;</span><span class="f_BodyText"> to lower case.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">TO_UPPER(&lt;string&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Converts </span><span class="f_BodyText" style="font-style: italic;">&lt;string&gt;</span><span class="f_BodyText"> to upper case.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">TRIM(&lt;string&gt;)</span><br>
<span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">TRIM(&lt;string&gt;, &lt;trimChars&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Removes trailing and leading white spaces from </span><span class="f_BodyText" style="font-style: italic;">&lt;string&gt;</span><span class="f_BodyText">. If </span><span class="f_BodyText" style="font-style: italic;">&lt;trimChars&gt;</span><span class="f_BodyText"> is specified, all leading and trailing characters in the set of </span><span class="f_BodyText" style="font-style: italic;">&lt;trimChars&gt;</span><span class="f_BodyText"> are removed.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">TRIM_LEFT(&lt;string&gt;)</span><br>
<span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">TRIM_LEFT(&lt;string&gt;, &lt;trimChars&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Removes the specified leading characters from </span><span class="f_BodyText" style="font-style: italic;">&lt;string&gt;</span><span class="f_BodyText">.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">TRIM_RIGHT(&lt;string&gt;)</span><br>
<span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">TRIM_RIGHT(&lt;string&gt;, &lt;trimChars&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Removes the specified trailing characters from </span><span class="f_BodyText" style="font-style: italic;">&lt;string&gt;</span><span class="f_BodyText">. </span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">VB_COMMENT(&lt;wrap_length&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Converts the notes for the element currently in scope to Visual Basic style comments.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">WRAP_COMMENT(&lt;comment&gt;, &lt;wrap_length&gt;, &lt;indent&gt;, &lt;start_string&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Wraps the text </span><span class="f_BodyText" style="font-style: italic;">&lt;comment&gt;</span><span class="f_BodyText"> at width </span><span class="f_BodyText" style="font-style: italic;">&lt;wrap_length&gt;</span><span class="f_BodyText"> putting </span><span class="f_BodyText" style="font-style: italic;">&lt;indent&gt;</span><span class="f_BodyText"> and </span><span class="f_BodyText" style="font-style: italic;">&lt;start_string&gt;</span><span class="f_BodyText"> at the beginning of each line. For example:</span></p>
<p class="p_Code"><span class="f_Code">$behavior = %WRAP_COMMENT(opBehavior, &quot;40&quot;, &quot;&nbsp; &quot;, &quot;//&quot;)%</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="952" bgcolor="#efeff7" style="width:952px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="952" bgcolor="#f7f7ff" style="width:952px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText" style="font-style: italic;">&lt;wrap_length&gt;</span><span class="f_TiporNoteText"> must still be passed as a string, even though </span><span class="f_TiporNoteText" style="font-weight: bold;">WRAP_COMMENT</span><span class="f_TiporNoteText"> treats this parameter as an integer.</span></p>
</td>
</tr>
</table>
</div>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">WRAP_LINES(&lt;text&gt;, &lt;wrap_length&gt;, &lt;start_string&gt;[, &lt;end_string])</span></p>
<p class="p_BodyText"><span class="f_BodyText">Wraps</span><span class="f_BodyText"> </span><span class="f_BodyText" style="font-style: italic;">&lt;text&gt;</span><span class="f_BodyText"> as designated to be </span><span class="f_BodyText" style="font-style: italic;">&lt;wrap_length&gt;</span><span class="f_BodyText">, adding </span><span class="f_BodyText" style="font-style: italic;">&lt;start_string&gt;</span><span class="f_BodyText"> to the beginning of every line and </span><span class="f_BodyText" style="font-style: italic;">&lt;end_string&gt;</span><span class="f_BodyText"> to the end of the line if it is specified.</span></p>
<p style="margin: 14px 0px 0px 0px;"><span style="font-size: 10pt; font-style: italic; font-weight: bold; color: #000000;">XML_COMMENT(&lt;wrap_length&gt;)</span></p>
<p class="p_BodyText"><span class="f_BodyText">Converts the notes for the element currently in scope to XML-style comments.</span></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
